Skip to content

Conversation

@jenniemeier
Copy link
Collaborator

Added / updated links, minor changes to bullet list punctuation.

A couple notes on this section:

  • In areas where CAS Beacon Signals and SMT Beacon Signals are used, I updated the terminology linking from the more general Beacon Signals to CAS Beacon or SMT Beacon as both of these terms contain details about their specific Beacon Signals in their definitions. However, given the number of times these terms appear in the spec, I think it would be a good idea to consider adding the terms CAS Beacon Signal and SMT Beacon Signal to the terminology. I'll open this in an Issue for discussion.
  • We are inconsistent in the way we do our bullet point list punctuation, and while this is easy to fix in some of the simple lists, it becomes less clear when sub-bullets and sub-sub-bullets are involved, as well as when a bullet contains several sentences. I'll open an Issue for discussion on this as well.

Added / updated links, minor changes to bullet list punctuation.
@parasyte
Copy link
Collaborator

There are a lot of good changes here, but I think we need to be careful about how the bulleted and numbered lists are written. For instance, #291 (comment)

@jenniemeier
Copy link
Collaborator Author

I definitely agree that we need to be careful on the bulleted and numbered lists, and want to make sure we're consistent throughout the spec. Are there set guidelines we're using to determine if something is bulleted or numbered? This is flagged in PR #295 as well as there appear to be some inconsistencies.

@parasyte
Copy link
Collaborator

Are there set guidelines we're using to determine if something is bulleted or numbered?

I think we try to use numbered (ordered) lists for procedures that need to be performed in the given order, and bulleted (unordered) lists for grouping items and concepts in a way that is more readable than a long paragraph. I'm sure it's a very general guideline, with plenty of flexibility and overlap, and opinions may differ.

One exception I can think of is enumeration. "So-and-so covers these N things:" followed by a list numbered 1 - N.

The STE specification itself has some recommendations for writing vertical lists. I am not terribly familiar with it, but probably a good reference.

@danpape
Copy link
Collaborator

danpape commented Jan 28, 2026

There are a lot of good changes here, but I think we need to be careful about how the bulleted and numbered lists are written. For instance, #291 (comment)

I agree with this and the discussion in #291, so hopefully we can get rid of the new semicolons before merging this one.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants